[CF-4208] Add `--name`/`--status` filtering to on-prem application list by paras-negi-flink · Pull Request #3428 · confluentinc/cli

Paras Negi (paras-negi-flink) · 2026-08-02T08:51:50Z

Release Notes

New Features

Added --name and --status filters to the on-prem (Confluent Platform / CMF) confluent flink application list command, to filter large environments server-side instead of "list everything then grep".

Checklist

Stacked on #3424 (--page-size). Base branch is cli-cf-4208-flink-list-limit-filter, so this diff shows only the filtering change. Review/merge #3424 first.

What

Confluent Platform (CMF on-prem) only — filtering half of CF-4208; Confluent Cloud flink commands are untouched.

flink application list had no filtering, so at scale the only pattern was "list everything then grep" (CF-4202). This adds server-side filtering:

--name — by application name; supports a trailing * wildcard (e.g. --name my-app*).
--status — by Flink job state (RUNNING, FINISHED, FAILED, CANCELED, RECONCILING, COMPLETED, UNKNOWN).

Both compose into CMF's single generic filter query as name=<value>,state=<value>; ListApplications gains a filter argument applied before pagination. An unknown --status prints a [WARN] to stderr but still queries, since CMF treats an unknown state as a no-match (matching statement list --status).

Blast Radius

Scoped to application list; with neither flag set, behavior is unchanged (no filter param). No CmfClientInterface/mock change. Non-breaking, easy to revert.

References

Jira: CF-4208; motivation CF-4202.
Base PR this stacks on: [CF-4208] Add --page-size to on-prem Flink list commands #3424.

Test & Review

Unit TestBuildApplicationFilter: name / wildcard / status / combined composition (name=a*,state=RUNNING).
Integration: --name exact + wildcard, --status match / no-match / invalid (asserts [WARN] + empty), combined --name+--status; help golden regenerated. make lint clean.

# combined --name + --status (AND semantics)
$ confluent flink application list --environment default --name default-application-1* --status reconciling
          Name          | Environment |     Job Name      | Job Status
------------------------+-------------+-------------------+--------------
  default-application-1 | default     | State machine job | RECONCILING

# unrecognized --status -> visible warning, still queries
$ confluent flink application list --environment default --status bogus -o json
[WARN] Invalid status "BOGUS". Valid statuses are "RUNNING", "FINISHED", "FAILED", "CANCELED", "RECONCILING", "COMPLETED", and "UNKNOWN".
[]

🤖 Generated with Claude Code

confluent-cla-assistant · 2026-08-02T08:51:59Z

🎉 All Contributor License Agreements have been signed. Ready to merge.
_{Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.}

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds application-list filtering support for Flink on-prem by wiring CLI flags into the CMF “filter” query parameter and updating the on-prem test server + integration fixtures to exercise name/status filtering behavior.

Changes:

Add --name (wildcard suffix supported) and --status flags to flink application list, and build a CMF filter query from them.
Extend the CMF REST client ListApplications to accept an optional filter and include it in requests.
Update the on-prem test server to emulate CMF-side filtering and add new integration test cases + golden outputs.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
test/test-server/flink_onprem_handler.go	Emulates CMF `filter` behavior for on-prem application listing.
pkg/flink/cmf_rest_client.go	Adds `filter` support to the REST client listing call.
internal/flink/command_application_list.go	Introduces `--name/--status` flags and composes the CMF filter query.
internal/flink/command_application_list_test.go	Unit-tests the filter composition helper.
test/flink_onprem_test.go	Adds integration scenarios for list filtering.
test/fixtures/output/flink/application/*.golden	Golden outputs for the new filtering scenarios and updated help text.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+	switch key {
+	case "name":
+		name, _ := app.Metadata["name"].(string)
+		if prefix, isWildcard := strings.CutSuffix(value, "*"); isWildcard {
+			return strings.HasPrefix(name, prefix)
+		}
+		return name == value
+	case "state":
+		if app.Status == nil {
+			return false
+		}
+		jobStatus, ok := (*app.Status)["jobStatus"].(map[string]interface{})
+		if !ok {
+			return false
+		}
+		state, _ := jobStatus["state"].(string)
+		return strings.EqualFold(state, value)
+	default:
+		return true
+	}


+	for _, expr := range strings.Split(filter, ",") {
+		key, value, found := strings.Cut(expr, "=")
+		if !found {
+			continue
+		}


Steven Gagniere (sgagniere)

Hi, I have a few comments:

Steven Gagniere (sgagniere) · 2026-08-06T19:27:36Z


 	cmd.Flags().String("environment", "", "Name of the Flink environment.")
+	cmd.Flags().String("name", "", `Filter the Flink applications by name. Supports wildcards, for example "my-app*".`)
+	cmd.Flags().String("status", "", "Filter the Flink applications by status.")


I think we should name this state to match the filter key.

Steven Gagniere (sgagniere) · 2026-08-06T19:36:25Z

+// "state=" filter, per the cmf-sdk-go GetApplications filter documentation. Unknown values are
+// still forwarded (the server returns no matches rather than erroring); this list only drives
+// the advisory --status warning.
+var allowedApplicationStatuses = []string{"RUNNING", "FINISHED", "FAILED", "CANCELED", "RECONCILING", "COMPLETED", "UNKNOWN"}


Just to confirm: are all of these statuses accepted filter arguments? The spec's description for filterParam implies that only RUNNING or FAILED are valid; so the description may be out of date for the spec.

The on-prem Flink (CPF/CMF) list commands loop over a hardcoded 100-item page size with no way to control it, so listing a large environment costs many serial round trips (~51 requests for 5000 applications). Add a --page-size flag to every paginated on-prem list command so callers can fetch the full list in fewer, larger requests. It defaults to 100, which preserves today's behavior and output. Collapse the 12 duplicated pagination loops in the CMF client into a single generic listAllPages helper that takes the page size. The requested size is passed through to the CMF page/size API; the loop still terminates on the first empty page. Server-side filtering for `application list` is deliberately left out and will follow in a separate PR stacked on this one. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

…logical pagination cases - Reword the --page-size help so it reads as a per-request batch size, not a cap on total results (regenerate the affected help/usage goldens). - Add an integration case for --page-size > MaxInt32 (3000000000), exercising the previously untested upper-bound branch of getPageSize (reuses the invalid golden). - Drop the statement/detached-savepoint --page-size cases: those mock handlers ignore the size param, so the cases only verified flag plumbing (already covered by the help goldens) rather than pagination. The applications case (mock genuinely pages) plus TestListAllPages remain the real coverage. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

…e validation Per review on #3424: - Default the flag to 100 (matching the documented behavior) instead of the 0 sentinel, and drop the redundant "Defaults to 100." text since pflag now renders "(default 100)". - Change the flag type to Int32 and read it directly, removing the hand-rolled range validation. Out-of-range input is now rejected by the flag parser itself (no client-side validation not backed by the spec), which also closes the int32-overflow concern. Non-positive values fall back to the default page size in listAllPages. Regenerated the affected help and usage goldens. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Stacked on the --page-size PR. Add server-side filtering to `flink application list` via --name (supports a "*" suffix wildcard) and --status, composed into the CMF applications "filter" query (name=<value>,state=<value>). ListApplications gains a filter parameter that is applied via the SDK's .Filter(...) before pagination. An unrecognized --status prints a [WARN] to stderr but still queries, since the CMF server treats an unknown state as a no-match rather than an error. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

sonarqube-confluent · 2026-08-08T05:31:42Z

Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
90.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

Paras Negi (paras-negi-flink) mentioned this pull request Aug 5, 2026

[CF-4208] Add --page-size to on-prem Flink list commands #3424

Merged

11 tasks

Paras Negi (paras-negi-flink) marked this pull request as ready for review August 6, 2026 18:50

Paras Negi (paras-negi-flink) requested a review from a team as a code owner August 6, 2026 18:50

Copilot AI lite review requested due to automatic review settings August 6, 2026 18:50

Copilot AI reviewed Aug 6, 2026

View reviewed changes

Steven Gagniere (sgagniere) reviewed Aug 6, 2026

View reviewed changes

airlock-confluentinc Bot force-pushed the cli-cf-4208-application-filtering branch 2 times, most recently from f5c4f57 to 7a68092 Compare August 7, 2026 19:02

Paras Negi (paras-negi-flink) and others added 3 commits August 8, 2026 09:30

airlock-confluentinc Bot force-pushed the cli-cf-4208-application-filtering branch from 7a68092 to bbb15bf Compare August 8, 2026 04:08

airlock-confluentinc Bot force-pushed the cli-cf-4208-application-filtering branch from bbb15bf to a153efd Compare August 8, 2026 05:08

Base automatically changed from cli-cf-4208-flink-list-limit-filter to main August 8, 2026 08:04

Navigation Menu

Uh oh!

[CF-4208] Add `--name`/`--status` filtering to on-prem application list - #3428

[CF-4208] Add `--name`/`--status` filtering to on-prem application list#3428
Paras Negi (paras-negi-flink) wants to merge 4 commits into
mainfrom
cli-cf-4208-application-filtering

Paras Negi (paras-negi-flink) commented Aug 2, 2026 •

edited by atlassian Bot

Loading

Uh oh!

confluent-cla-assistant Bot commented Aug 2, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Steven Gagniere (sgagniere) left a comment

Uh oh!

Steven Gagniere (sgagniere) Aug 6, 2026

Uh oh!

Steven Gagniere (sgagniere) Aug 6, 2026

Uh oh!

sonarqube-confluent Bot commented Aug 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Paras Negi (paras-negi-flink) commented Aug 2, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Checklist

What

Blast Radius

References

Test & Review

Uh oh!

confluent-cla-assistant Bot commented Aug 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Steven Gagniere (sgagniere) left a comment

Choose a reason for hiding this comment

Uh oh!

Steven Gagniere (sgagniere) Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

Steven Gagniere (sgagniere) Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqube-confluent Bot commented Aug 8, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Paras Negi (paras-negi-flink) commented Aug 2, 2026 •

edited by atlassian Bot

Loading

confluent-cla-assistant Bot commented Aug 2, 2026 •

edited

Loading